// 
// ProtocolException.cs
//  
// Author:
//       Tomáš Vondráček <tomas.vondracek@gmail.com>
// 
// Copyright (c) 2010 Tomas Vondracek
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using IM.Interfaces.Protocols;

namespace IM.Protocols
{
	/// <summary>
	/// base exception for protocol exceptions
	/// </summary>
	public class ProtocolException : Exception
	{
		string protocolName;
		IProtocol protocol;
		
		public ProtocolException ()
			:base()
		{
		}
		
		public ProtocolException(string message)
			:base(message)
		{
		
		}
		
		public ProtocolException (string message, Exception innerException)
			: base(message, innerException)
		{
			
		}
		
		public ProtocolException (string message, IProtocol protocol, Exception innerException)
			: base(message, innerException)
		{
			this.protocol = protocol;
		}
		
		public ProtocolException (string message, string protocol, Exception innerException)
			: base(message, innerException)
		{
			this.protocolName = protocol;
		}
	
		/// <summary>
		/// Protocol affected by the exception;
		/// Might be null
		/// </summary>
		public IProtocol Protocol
		{
			get {
				return this.protocol;
			}
		}

		/// <summary>
		/// Name of protocol affected by the exception;
		/// Might be null or emtpy
		/// </summary>
		public string ProtocolName
		{
			get {
				return this.protocolName;
			}
		}
}
}

